##########################################################################
#
#  Copyright (c) 2019, Murray Stevenson. All rights reserved.
#
#  Redistribution and use in source and binary forms, with or without
#  modification, are permitted provided that the following conditions are
#  met:
#
#      * Redistributions of source code must retain the above
#        copyright notice, this list of conditions and the following
#        disclaimer.
#
#      * Redistributions in binary form must reproduce the above
#        copyright notice, this list of conditions and the following
#        disclaimer in the documentation and/or other materials provided with
#        the distribution.
#
#      * Neither the name of John Haddon nor the names of
#        any other contributors to this software may be used to endorse or
#        promote products derived from this software without specific prior
#        written permission.
#
#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
#  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
#  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
#  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
#  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
#  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
#  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
#  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
#  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
##########################################################################

import IECore
import Gaffer
import GafferCycles

Gaffer.Metadata.registerNode(

	GafferCycles.CyclesShaderBall,

	"description",
	"""
	Generates scenes suitable for rendering shader balls with Cycles.
	""",

	"layout:activator:deviceIncludesCPU", lambda node : IECore.StringAlgo.matchMultiple( "CPU", node["device"]["value"].getValue(), ),

	plugs = {

		"environment" : {

			"description" :
			"""
			An environment map used for lighting. Should be in latlong
			format.
			""",

			"plugValueWidget:type" : "GafferUI.FileSystemPathPlugValueWidget",
			"path:leaf" : True,
			"path:valid" : True,
			"path:bookmarks" : "texture",

		},

		"device" : {

			"description" :
			"""
			The device to render the shader ball on.
			""",

		},

		"threads" : {

			"description" :
			"""
			The number of threads used by Cycles to render the
			shader ball. A value of 0 uses all cores, and negative
			values reserve cores for other uses - to be used by
			the rest of the UI for instance.
			""",

			"layout:activator" : "deviceIncludesCPU",

		},

	}

)
